Pular para o conteúdo principal

GET /pedidos/{recibo}

Retorna um conjunto completo de dados do pedido encontrado a partir do recibo.

Parâmetros​

  • recibo (string, path): Recibo do pedido

Respostas​

200 - Status: 002 (Registro realizado)​

{
  "status": "001 (Registro realizado)",
  "descricao": "string"
}

200 - Status: 003 (Faturado)​

{
  "status": "003 (Faturado)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "numero-nota": "string",
    "numero-origem": "string",
    "status": "string",
    "descricao-status": "string",
    "tipo-pedido": "S", // Enum: [ S (saída), E (entrada) ]
    "vendedor": "string",
    "codicao-pagamento": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "data-pedido": "string",
    "data-faturado": "string",
    "observacao": "string",
    "valor-frete": "string",
    "valor-total": "string",
    "itens": [
      {
        "produto": "string",
        "nome": "string",
        "quantidade": "string",
        "valor-unitario": "string"
      }
    ]
  }
}

200 - Status: 004 (Faturado em nota)​

{
  "status": "004 (Faturado em nota)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "numero-nota": "string",
    "numero-origem": "string",
    "status": "string",
    "descricao-status": "string",
    "tipo-pedido": "S", // Enum: [ S (saída), E (entrada) ]
    "vendedor": "string",
    "codicao-pagamento": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "data-pedido": "string",
    "data-faturado": "string",
    "observacao": "string",
    "valor-frete": "string",
    "valor-total": "string",
    "itens": [
      {
        "produto": "string",
        "nome": "string",
        "quantidade": "string",
        "valor-unitario": "string"
      }
    ]
  }
}

200 - Status: 010 (Documento cancelado)​

{
  "status": "010 (Documento cancelado)",
  "descricao": "string",
  "data": {
    "id": "string",
    "numero": "string",
    "numero-nota": "string",
    "numero-origem": "string",
    "status": "string",
    "descricao-status": "string",
    "tipo-pedido": "S", // Enum: [ S (saída), E (entrada) ]
    "vendedor": "string",
    "codicao-pagamento": "string",
    "cliente": {
      "tipo": "J", // Enum: [ F (Pessoa física), J (Pessoa jurídica) ]
      "nome": "string", // Este campo estara presente caso o cliente for do tipo F.
      "razao-social": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cnpj": "string", // Este campo estara presente caso o cliente for do tipo J.
      "cpf": "string" // Este campo estara presente caso o cliente for do tipo F.
    },
    "data-pedido": "string",
    "data-faturado": "string",
    "observacao": "string",
    "valor-frete": "string",
    "valor-total": "string",
    "itens": [
      {
        "produto": "string",
        "nome": "string",
        "quantidade": "string",
        "valor-unitario": "string"
      }
    ]
  }
}

200 - Status: 999 (Erro interno)​

{
  "status": "999 (Erro interno)",
  "descricao": "string",
  "data": {
    "erro": "string"
  }
}

Observações​

Este endpoint exige autenticação.
Utilize os seguintes cabeçalhos:

Authorization: Token `token_da_empresa`
Content-Type: application/json

Exemplo de requisição​

GET https://api.mysebr.com.br/nfemyse-v3/rest/pedidos/{recibo}